GET Notifications

Request notifications for results letters associated with a client program.

Request

Endpoint

GET {clientId}/api/v1/outreach?programName=someProgram&startDate=01/01/2000&endDate=01/01/2000&continuationToken=123abc&type=PcpResultsLetter

The GET Notifications requires the following information in the headers of an HTTP request:

HTTP Header	Description
Authorization	The HTTP Authorization request header contains the credentials to authenticate a user agent with a server.
Accept	The HTTP Accept request header contains information about the content types, expressed as MIME types, that the client can understand. The MIME types for the GET Notifications request is application/json

Path parameters

Parameter	Description	Type	Required/Optional
clientId	The clientId is a unique code that is provided by LetsGetChecked. The code is formed by 1 to 4 alphanumeric characters.	string	Required

Query parameters

Parameter	Description	Type	Required/Optional
programName	The LetsGetChecked program name.	string	Required
startDate	The program start date. LetsGetChecked expects an ISO 8601 UTC date format.	string	Required
endDate	The program end date. LetsGetChecked expects an ISO 8601 UTC date format.	string	Optional
continuationToken	The response contains an X-Continuation-Token HTTP header which represents a pointer to the last value on the response. Tips: You can use the value on the X-Continuation-Token as the continuationToken query parameter for the next request. There is an upper limit of 25 on the number of results returned in the request. When all results have been returned, the X-Continuation-Token returns a null value.	string	Optional
type	Type can be one of the following values: PcpResultsLetter PatientResultsLetter	string	Optional

Response

Status Codes

Status Code	Description
200	Returned whenever one or more notifications are found found.
400	Returned whenever a param is send in an invalid format.
401	Returned whenever the Authorization header is not sent or is not a valid one.
503	Returned whenever the service is unavailable.
500	Returned whenever some generic error occurred in the server.

The sample response is a single JSON structure that contains a list of items with the following fields:

Property	Description	Type
Barcode / numerical code	Formatted as LGC-0000-0000-0000, where 0 indicates any digit.	string
programName	The LetsGetChecked program name.	string
calls	This property is currently not in use and does not have a structure defined yet so its value is always an empty array.	object(callStatus)
pcpLetterSendStatus	The results letter sent to patient’s Primary Care Provider (PCP) after results are released.	object (pcpLetterSendStatus)
{pcpLetterSendStatus}/Status	The following value is possible: DeliverySent	string
{pcpLetterSendStatus}/FailureReason	Currently, FailureReason property is an empty string since we don't have it implemented. In the future, it will have a maximum of 200 characters.	string
{pcpLetterSendStatus}/UpdatedAt	The timestamp, in UTC time, in ISO 8601 format.	string
patientLetterSendStatus	The patient's results letter that is sent after the results are released.	object (patientLetterSendStatus)
{patientLetterSendStatus}/Status	The following value is possible: DeliverySent	string
{patientLetterSendStatus}/FailureReason	Currently, FailureReason property is an empty string since we don't have it implemented. In the future, it will have a maximum of 200 characters.	string
{patientLetterSendStatus}/UpdatedAt	The timestamp, in UTC time, in ISO 8601 format.	string

Sample Response

[
    {
        "barcode": "LGC-8391-5974-4700",
        "programName": "TestProgram",
        "calls": [],
        "pcpLetterSendStatus": null,
        "patientLetterSendStatus": {
            "status": "DeliverySent",
            "failureReason": "",
            "updatedAt": "2022-01-26T17:42:13.2923845"
        }
    },
    {
        "barcode": "LGC-2608-9550-6629",
        "programName": "TestProgram",
        "calls": [],
        "pcpLetterSendStatus": {
            "status": "DeliverySent",
            "failureReason": "",
            "updatedAt": "2022-01-26T17:42:19.7055361"
        },
        "patientLetterSendStatus": {
            "status": "DeliverySent",
            "failureReason": "",
            "updatedAt": "2022-01-26T17:42:19.8239463"
        }
    },
    {
        "barcode": "LGC-3953-5218-9549",
        "programName": "TestProgram",
        "calls": [],
        "pcpLetterSendStatus": {
            "status": "DeliverySent",
            "failureReason": "",
            "updatedAt": "2022-01-26T17:43:12.8324941"
        },
        "patientLetterSendStatus": {
            "status": "DeliverySent",
            "failureReason": "",
            "updatedAt": "2022-01-26T17:43:13.0559301"
        }
    }
]